You are here:

Get Data Source Server Roles

{ getRolesByServer }

Returns all roles IDs and its settings for a server.

Method

/API3/dataSources/getRolesByServer

API Section: /API3/dataSources

API Version: 3.0

From Release: 2023.10

Usage: REST API and Client SDK libraries. REST APIs via POST actions only.

Usage by:

Enterprise Admin

Input Parameters

Name

serverId

Type

string

Description

The server's system ID

Output Response

Successful Result Code

200

Response List Type

ItemRolePair[]

Description of Response Type

Object with role and role access types.. Note that the response is returned as a list of items of this object type.

Examples

Data Source Operations (JavaScript):

This example demonstrates how to operate with data sources.

The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.

// URL of the Pyramid installation and the path to the API 3.0 REST methods
var pyramidURL = "http://mysite.com/api3/";

// step 1: authenticate admin account and get token
// NOTE: callApi method is a generic REST method shown below.
let token = callApi("authentication/authenticateUser",{
	"userName":"adminUser",
	"password":"12345678"
},"",false);
log("got token "+token);

// step 2: find roles in the system
let findRole = callApi("access/findRoles",{
	"searchValue": "role1",
	"searchMatchType": 2//SearchMatchType.Equals
},token // admin token generated above
);
let roleId=findRole[0].roleId;
log("found role with id= "+ roleId);

// step 3: add a new data source server (IMDB)
let createDataServer = callApi("dataSources/createDataServer",{
	"serverName": "new server",
	"serverType":13,// use the server type enumeration. 13 = IMDB
	"serverIp": "172.29.3.178",
	"port":5060,
	"serverAuthenticationMethod":0,//ServerAuthenticationMethod.UserPassword
	"userName":"default",
	"password":"password",
},token // admin token generated above
);
let dataServerId=createDataServer.modifiedList[0].id;
log("created dataserver= "+ dataServerId);

// step 4: secure server from step 3 with roles
let addRolesToServer = callApi("dataSources/addRolesToServer",{
	"itemId":dataServerId,
	"itemRolePairList":[{
		"roleId":roleId,
		"accessType":2//AccessType.Read
	}]
},token);
log("added role1 to the newly created server");

// step 5: optional: check the roels on the server
let getRolesByServer= callApi("dataSources/getRolesByServer",dataServerId,token);

// step 6: recognize an existing database on the server
//use this method when you want to address the database in Pyramid
let recognizeDataBase = callApi("dataSources/recognizeDataBase",{
	"serverId":dataServerId, //this comes from step 3 above
	"dbName":"PyramidDemo"
},token);
let databaseId=recognizeDataBase.modifiedList[0].id;
log("found database "+databaseId+" at the dataserver");

// step 7: secure the database from step 3 with roles
let addRolesToDataBase = callApi("dataSources/addRolesToDataBase",{
	"itemId":databaseId,
	"itemRolePairList":[{
		"roleId":roleId,
		"accessType":3//AccessType.Write
	}]
},token);

// step 8A: read in an existing data model from a PIE file
let file="http://myOtherSite.com/SampleModel.pie";
let modelData=readPieFile(file);

// step 8B: import the file content into Pyramid
let importModel = callApi("dataSources/importModel",{
	"fileZippedData":modelData, //model data from step 8A
	"databaseId":databaseId, //from step 6
	"materializedRoleAssignmentType":3//MaterializedRoleAssignmentType.ForceParentRoles
},token);


// step 9: secure the model from step 3 with roles
let addRolesToModel = callApi("dataSources/addRolesToModel",{
	"itemId":importModel.modelId, //from step 8B
	"itemRolePairList":[{
		"roleId":roleId,
		"accessType":3//AccessType.Write
	}]
},token);

//step 10: delete the model
let deleteMaterializedModel = callApi("dataSources/deleteMaterializedModel",importModel.modelId,token);


//step 11: delete the database
let deleteDataBase=callApi("dataSources/deleteDataBase",databaseId,token);

//step 12: delete the dta source (server)
let deleteDataSource = callApi("dataSources/deleteDataSource",dataServerId,token);

function log(msg){
	document.write(msg);
	console.log(msg);
}

// ##### generic REST API calling method ##############
function callApi(path,data,token="",parseResult=true){
	var xhttp = new XMLHttpRequest();
	xhttp.open("POST", pyramidURL+path, false);
	xhttp.setRequestHeader("paToken",token)
	xhttp.send(JSON.stringify(data));
	if(parseResult){
		return JSON.parse(xhttp.responseText);
	}else{
		return xhttp.responseText;
	}
}

//example function to read in the contents of a 'PIE' file that contains
//exported Pyramid content.
function readPieFile(file){
	var rawFile = new XMLHttpRequest();
	rawFile.open("GET", file, false);
	rawFile.send(null);
	rawFile.onreadystatechange = function () {
		if (request.readyState === 4 && request.status === 200) {
			return request.responseText;
        }
    }
}

Code Snippets

Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

TypeScript

Curl

Java

Python

PHP

curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/dataSources/getRolesByServer" \
 -d ''

import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.DataSourcesServiceApi;

import java.util.*;
import java.time.*;

public class DataSourcesServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DataSourcesServiceApi apiInstance = new DataSourcesServiceApi();
        // Initialize the serverId parameter object for the call
        String serverId = serverId_example; // Create the input object for the operation, type: String 

        try {
            // "array[ItemRolePair]" is only psaudo-code to symbolize list of type and not the actual usage 
            array[ItemRolePair] result = apiInstance.getRolesByServer(serverId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataSourcesServiceApi#getRolesByServer");
            e.printStackTrace();
        }
    }
}

import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.DataSourcesServiceApi("http://Your.Server.URL")

// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");

const serverId = serverId_example; // {String} 

api.getRolesByServer(serverId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class getRolesByServerExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new DataSourcesServiceApi();
        // Initialize the serverId parameter object for the call
        var serverId = serverId_example;  // Create the input object for the operation, type: String | 

        try {
            // Returns all roles IDs and its settings for a server.
            // "array[ItemRolePair]" is only psaudo-code to symbolize array of type and not the actual usage 
            array[ItemRolePair] result = apiInstance.getRolesByServer(serverId);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling DataSourcesServiceApi.getRolesByServer: " + e.Message );
        }
    }
}

import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import DataSourcesServiceApi
from pprint import pprint

        
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = DataSourcesServiceApi(api_client)
    # Initialize the serverId parameter object for the call
    serverId = serverId_example # String | 

    try:
        # Returns all roles IDs and its settings for a server.
        api_response = api_instance.get_roles_by_server(serverId)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DataSourcesServiceApi->getRolesByServer: %s\n" % e)

<?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DataSourcesServiceApi();
$serverId = serverId_example; // String | 

try {
    $result = $api_instance->getRolesByServer($serverId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataSourcesServiceApi->getRolesByServer: ', $e->getMessage(), PHP_EOL;
}
?>

Feedback

Couldn't find what I was looking for

Help was confusing, unclear or incomplete

Instructions didn't work